<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IEffectTargetHost,mx.effects.IEffectTargetHost,addDataEffectItem,getRendererSemanticValue,removeDataEffectItem,unconstrainRenderer" name="keywords">
<title>mx.effects.IEffectTargetHost</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IEffectTargetHost - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/effects/IEffectTargetHost.html&amp;mx/effects/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IEffectTargetHost</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IEffectTargetHost"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.effects</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IEffectTargetHost</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../controls/listClasses/ListBase.html">ListBase</a></td>
</tr>
</table>
<p></p>
  The IEffectTargetHost interface defines the interface that lets you access the 
  target list-based control of a data effect. 
  All list-based controls implement this interface.
  This interface enables an instance of an effect class to communicate with the 
  list-based control on which the effect is playing. 
  This interface is also used for determining whether to play an effect based on if a data item is 
  added, removed, or replaced in the target control. 
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../controls/listClasses/ListBase.html" target="">mx.controls.listClasses.ListBase</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addDataEffectItem()">addDataEffectItem</a>(target:Object):void</div>
<div class="summaryTableDescription">
      Adds an item renderer if a data change effect is running.</div>
</td><td class="summaryTableOwnerCol">IEffectTargetHost</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getRendererSemanticValue()">getRendererSemanticValue</a>(target:Object, semanticProperty:String):Object</div>
<div class="summaryTableDescription">
      Returns <code>true</code> or <code>false</code> 
      to indicates whether the effect should play on the target.</div>
</td><td class="summaryTableOwnerCol">IEffectTargetHost</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeDataEffectItem()">removeDataEffectItem</a>(target:Object):void</div>
<div class="summaryTableDescription">
      Removes an item renderer if a data change effect is running.</div>
</td><td class="summaryTableOwnerCol">IEffectTargetHost</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#unconstrainRenderer()">unconstrainRenderer</a>(item:Object):void</div>
<div class="summaryTableDescription">
      Called by an <code>UnconstrainItemAction</code> effect
      as part of a data change effect if the item renderers corresponding
      to certain data items need to move outside the normal positions
      of item renderers in the control.</div>
</td><td class="summaryTableOwnerCol">IEffectTargetHost</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addDataEffectItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addDataEffectItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addDataEffectItem(target:Object):void</code><p>
      Adds an item renderer if a data change effect is running.
      The item renderer should correspond to a recently added
      data item in the data provider's collection that isn't
      yet being displayed.
     
      </p><p>This function will be called by an <code>AddItemAction</code>
      effect as part of a data change effect to specify the point
      at which a data item added to a collection begins to be displayed
      by the control using an item renderer.</p>
     
      <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; The item renderer to add to the control's layout.
     </td>
</tr>
</table>
</div>
<a name="getRendererSemanticValue()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getRendererSemanticValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getRendererSemanticValue(target:Object, semanticProperty:String):Object</code><p>
      Returns <code>true</code> or <code>false</code> 
      to indicates whether the effect should play on the target.
      The EffectTargetFilter class calls this method when you set 
      the <code>filter</code> property on a data effect. 
      For example, you set <code>filter</code> property 
      to <code>addItem</code> or <code>removeItem</code>.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; An item renderer
     
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">semanticProperty</span>:String</code> &mdash; The semantic property of the renderer
      whose value will be returned.
      
      </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; <code>true</code> or <code>false</code> 
      to indicates whether the effect should play on the target. 
     </td>
</tr>
</table>
</div>
<a name="removeDataEffectItem()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeDataEffectItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeDataEffectItem(target:Object):void</code><p>
      Removes an item renderer if a data change effect is running.
      The item renderer must correspond to data that has already
      been removed from the data provider collection.
     
      This function will be called by a <code>RemoveItemAction</code>
      effect as part of a data change effect to specify the point
      at which a data item ceases to displayed by the control using
      an item renderer.
     
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; The item renderer to remove from the control's layout.
     </td>
</tr>
</table>
</div>
<a name="unconstrainRenderer()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">unconstrainRenderer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function unconstrainRenderer(item:Object):void</code><p>
      Called by an <code>UnconstrainItemAction</code> effect
      as part of a data change effect if the item renderers corresponding
      to certain data items need to move outside the normal positions
      of item renderers in the control. 
      The control does not attempt to position the item render for the 
      duration of the effect.
     
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">item</span>:Object</code> &mdash; The item renderer that is a target of the effect.
     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
